-
Notifications
You must be signed in to change notification settings - Fork 8.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOCS] Updates intro doc #58161
[DOCS] Updates intro doc #58161
Conversation
Pinging @elastic/kibana-docs (Team:Docs) |
cla/check |
docs/user/introduction.asciidoc
Outdated
|
||
Setting up Kibana is a snap. You can install Kibana and start exploring your Elasticsearch indices in minutes -- no | ||
code, no additional infrastructure required. | ||
* **{kib} is an open-source analytics and visualization platform.** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For all three of these bullets, I would remove {kib} is
. So it would look like:
- An open-source analytics and visualization platform.
- A UI for managing Elasticsearch clusters.
- A centralized hub for our solutions.
docs/user/introduction.asciidoc
Outdated
Manage your security settings, assign user roles, monitor the Stack, | ||
ingest and roll up your data...the list goes on. | ||
|
||
* **{kib} is a centralized hub for our solutions.** — From log analytics to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the —
on purpose?
docs/user/introduction.asciidoc
Outdated
|
||
[float] | ||
[[get-data-into-kibana]] | ||
=== Try {kib} with our data sets and tutorials |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section doesn't encompass all of the ways users can get data into Kibana. Since this is the intro, what if a user is interested in going through the process of loading the data themselves? I think this content is a better fit in our new Get data into Kibana
section.
Here, I would say something like:
`Before you can build beautiful visualizations and dashboards, you must first get your data into Kibana. Kibana supports several ways to get your data in, such as file upload, etc.
If you're not ready to use your own data, our <<add-sample-data, sample data sets>> enable you to take {kib} for a test ride ...
docs/user/introduction.asciidoc
Outdated
|
||
* <<canvas, Canvas>> gives you the ability to present your data in a | ||
visually compelling, pixel-perfect report. Give your data the “wow” factor | ||
needed to impress your CEO or to captivate people with a big-screen display.. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Double period
docs/user/introduction.asciidoc
Outdated
|
||
[float] | ||
[[more-ways-to-visualize]] | ||
=== Even more ways to visualize |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would remove this title. Line 88 does a good job of introducing this content, and these apps do more than visualize the data, they help with analysis too.
docs/user/introduction.asciidoc
Outdated
|
||
<<management, Management>> provides guided processes for managing all | ||
things Elastic Stack — indices, clusters, licenses, UI settings, index patterns, | ||
spaces, and more. Want to update your {es} indices? Set user roles and privileges? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since you already talk about spaces in Organize & secure
, I would leave it out here.
|
||
[float] | ||
[[explore-and-query]] | ||
=== Explore & query |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the consistency of Explore & query
, Visualize & analyze
, and Organize & secure
, but the other section titles use and
. Maybe make this consistent across all of these titles?
docs/user/introduction.asciidoc
Outdated
[[extend-your-use-case]] | ||
=== Extend your use case...or add a new one | ||
|
||
As a hub for our https://www.elastic.co/products/[solutions], {kib} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would remove our
. It makes it sound like these are Kibana's solutions when they are really Elastic's solutions.
docs/user/introduction.asciidoc
Outdated
|
||
[float] | ||
[[where-to-start-kibana]] | ||
=== Where do I start? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this section belongs in the introduction. I think users want to know what they are getting into before they learn about jumping in and setting up. This section is a better fit for the getting started section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i moved this section to the end.
docs/user/introduction.asciidoc
Outdated
(If a tutorial doesn’t exist for your data, go to the | ||
{beats-ref}/beats-reference.html[Beats overview] to learn about other data shippers | ||
in the {beats} family.) | ||
* Import log data using the file upload feature. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gchaps I don't know if we need to specify "log data" here. Maybe instead, we say "static" data? Simply because it's a one time thing. Also, are there docs we can link to for file upload?
docs/user/introduction.asciidoc
Outdated
From the home page, {kib} provides these options for getting data in: | ||
|
||
* <<add-sample-data, Add a sample data set>> and take {kib} for a test drive without loading data yourself. | ||
* Set up a data flow between your app and the Elastic Stack using our built-in tutorials. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A lot of these modules aren't necessarily app specific. For instance, metrics / logs on your infrastructure or security events. Maybe instead we make this sentence a bit more generic and simply say "Easily set up known data sources.." or "Set up a data flow to Elasticsearch.."
docs/user/introduction.asciidoc
Outdated
{beats-ref}/beats-reference.html[Beats overview] to learn about other data shippers | ||
in the {beats} family.) | ||
* Import log data using the file upload feature. | ||
* {ref}/getting-started-index.html[Index your data] in Elasticsearch. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know it's getting started, but some additional context might help here. If you're not using beats, then you're likely using our REST API or client libraries. "Index your data into Elasticsearch with REST API's or client libraries". That doesn't flow well, but gives a bit more context.
layers and data sources, mapping of individual geo points and shapes, | ||
and dynamic client-side styling. | ||
|
||
* <<TSVB, TSVB>> allows you to combine |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know "Time Series Visual Builder" is a mouthful, but are we really externally marketing this as TSVB now? I had thought it was just internal
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@alexfrancoeur there was an effort last year to change all instances of Time Series Visual Builder to TSVB.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah interesting, naming is hard 😄
LGTM @gchaps . I dropped a few comments in, mostly in the getting data into Kibana section. @VijayDoshi @AlonaNadler might want to give it a quick peek too |
|
||
{kib} also offers these features that address specific visualization needs. | ||
|
||
* <<visualize, Visualize>> allows you to display your data in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right now we make mention of Lens in the intro of Visualize & Analyze, but we don't mention it again any where else in the rest of the larger intro. I know it breaks up the 2 sentence pattern of the bullets, but maybe for the visualize bullet we add a middle sentence that just says "It's also home to Lens, a drag-and-drop interface for rapid ad-hoc chart building." If we use that verbiage we'll need to start the third sentence differently by taking out the "also."
* [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync. |
* [DOCS] Updates intro doc (#58161) * [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * [DOCS] Fixes broken images Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
* [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
Summary
This PR updates the introduction to Kibana doc to better tell the Kibana story.
[skip ci]
Preview:
http://kibana_58161.docs-preview.app.elstc.co/guide/en/kibana/master/introduction.html